# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.

defmodule GoogleApi.Language.V2.Model.XPSTablesModelColumnInfo do
  @moduledoc """
  An information specific to given column and Tables Model, in context of the Model and the predictions created by it.

  ## Attributes

  *   `columnId` (*type:* `integer()`, *default:* `nil`) - The ID of the column.
  *   `featureImportance` (*type:* `number()`, *default:* `nil`) - When given as part of a Model: Measurement of how much model predictions correctness on the TEST data depend on values in this column. A value between 0 and 1, higher means higher influence. These values are normalized - for all input feature columns of a given model they add to 1. When given back by Predict or Batch Predict: Measurement of how impactful for the prediction returned for the given row the value in this column was. Specifically, the feature importance specifies the marginal contribution that the feature made to the prediction score compared to the baseline score. These values are computed using the Sampled Shapley method.
  """

  use GoogleApi.Gax.ModelBase

  @type t :: %__MODULE__{
          :columnId => integer() | nil,
          :featureImportance => number() | nil
        }

  field(:columnId)
  field(:featureImportance)
end

defimpl Poison.Decoder, for: GoogleApi.Language.V2.Model.XPSTablesModelColumnInfo do
  def decode(value, options) do
    GoogleApi.Language.V2.Model.XPSTablesModelColumnInfo.decode(value, options)
  end
end

defimpl Poison.Encoder, for: GoogleApi.Language.V2.Model.XPSTablesModelColumnInfo do
  def encode(value, options) do
    GoogleApi.Gax.ModelBase.encode(value, options)
  end
end
